(credit: Wikimedia Commons)
Clay is a minimalistic Clojure tool for data visualization and literate programming, compatible with the Kindly convention.
For rendering documents like this one with Clay, you need to:
(kindly-default/setup!) and (clay/start!) (see below)To enjoy Clay's dynamic interaction, you also need to inform it about code evaluations. This requires some setup at the your editor.
See the suggested setup for popular editors below. If your favourite editor is not supported yet, let us talk and make it work.
(to be updated soon)
Please add the following command to your keybindings.json file at the VScode setup (you may pick another key, of course). This command would evaluate a piece of code and send the result to be visualized in Clay.
{
"key": "ctrl+shift+enter",
"command": "calva.runCustomREPLCommand",
"args": "(scicloj.clay.v2.api/handle-form! (quote $current-form))"
}
(to be updated soon)
Please load clay.el at your Emacs config.
It offers the following functions, that you may wish to create keybindings for:
| name | function |
|---|---|
clay/start | start clay if not started yet |
clay/show-namespace | save clj buffer and render it in the browser view |
clay/show-namespace-and-write-html | save clj buffer, render it in the browser view, and save the result as html |
clay/generate-and-show-namespace-quarto | (experimental) save clj buffer, generate an html document using Quarto, and show it in the browser view |
clay/send | send a single clj form to be rendered in the browser view |
clay/send-last-sexp | send the last s-expression |
clay/send-defun-at-point | send the defun-at-point |
Now, we can write a namespace and play with Clay.
(ns index
(:require [scicloj.clay.v2.api :as clay]
[scicloj.kindly.v3.api :as kindly]
[scicloj.kindly.v3.kind :as kind]
[scicloj.kindly-default.v1.api :as kindly-default]))Initialize Kindly's default.
(kindly-default/setup!):ok
Let us start Clay.
(clay/start!):clay
These initializations can also be done in a user.clj file, making them available for all namespaces in the project. The browser view should open automatically.
Showing the whole namespace:
(comment
(clay/show-doc! "notebooks/index.clj"))Writing the document:
(comment
(clay/show-doc-and-write-html!
"notebooks/index.clj"
{:toc? true}))Reopening the Clay view in the browser (in case you closed the browser tab previously opened by clay/start!)
(comment
(clay/browse!))These can be conveniently bound to functions and keys at your editor (to b documented soon).
Clay responds to user evaluations by displaying the result visually.
(+ 1111 2222)3333
In Emacs CIDER, after evaluation of a form (or a region), the browser view should show the evaluation result. In VSCode Calva, a similar effect can be achieved using the dedicated command and keybinding defined above.
The way things should be visualized is determined by the advice of Kindly. In this namespace we demonstrate Kindly's default advice. User-defined Kindly advices should work as well. Kindly advises tools (like Clay) about the kind of way a given context should be displayed, by assigning to it a so-called kind. Please refer to the Kindly documentation for details about specifying and using kinds.
By default, when there is no kind information provided by Kindly, values are pretty-printed.
(def people-as-maps
(->> (range 29)
(mapv (fn [i]
{:preferred-language (["clojure" "clojurescript" "babashka"]
(rand-int 3))
:age (rand-int 100)}))))(def people-as-vectors
(->> people-as-maps
(mapv (juxt :preferred-language :age))))people-as-maps[{:preferred-language "babashka", :age 80}
{:preferred-language "clojure", :age 92}
{:preferred-language "clojure", :age 10}
{:preferred-language "clojure", :age 66}
{:preferred-language "clojurescript", :age 57}
{:preferred-language "clojurescript", :age 94}
{:preferred-language "clojurescript", :age 31}
{:preferred-language "babashka", :age 58}
{:preferred-language "clojure", :age 75}
{:preferred-language "clojurescript", :age 86}
{:preferred-language "clojure", :age 34}
{:preferred-language "clojurescript", :age 44}
{:preferred-language "clojure", :age 41}
{:preferred-language "clojure", :age 80}
{:preferred-language "clojure", :age 30}
{:preferred-language "clojurescript", :age 38}
{:preferred-language "babashka", :age 48}
{:preferred-language "babashka", :age 10}
{:preferred-language "clojurescript", :age 41}
{:preferred-language "babashka", :age 89}
{:preferred-language "clojure", :age 56}
{:preferred-language "babashka", :age 78}
{:preferred-language "clojurescript", :age 18}
{:preferred-language "babashka", :age 71}
{:preferred-language "babashka", :age 83}
{:preferred-language "clojure", :age 91}
{:preferred-language "clojure", :age 39}
{:preferred-language "clojurescript", :age 42}
{:preferred-language "babashka", :age 36}]
people-as-vectors[["babashka" 80]
["clojure" 92]
["clojure" 10]
["clojure" 66]
["clojurescript" 57]
["clojurescript" 94]
["clojurescript" 31]
["babashka" 58]
["clojure" 75]
["clojurescript" 86]
["clojure" 34]
["clojurescript" 44]
["clojure" 41]
["clojure" 80]
["clojure" 30]
["clojurescript" 38]
["babashka" 48]
["babashka" 10]
["clojurescript" 41]
["babashka" 89]
["clojure" 56]
["babashka" 78]
["clojurescript" 18]
["babashka" 71]
["babashka" 83]
["clojure" 91]
["clojure" 39]
["clojurescript" 42]
["babashka" 36]]
With the the :kind/pprint kind, this can behaviour can be made explicit (overriding other inferred kinds if necessary).
(kind/pprint people-as-maps)[{:preferred-language "babashka", :age 80}
{:preferred-language "clojure", :age 92}
{:preferred-language "clojure", :age 10}
{:preferred-language "clojure", :age 66}
{:preferred-language "clojurescript", :age 57}
{:preferred-language "clojurescript", :age 94}
{:preferred-language "clojurescript", :age 31}
{:preferred-language "babashka", :age 58}
{:preferred-language "clojure", :age 75}
{:preferred-language "clojurescript", :age 86}
{:preferred-language "clojure", :age 34}
{:preferred-language "clojurescript", :age 44}
{:preferred-language "clojure", :age 41}
{:preferred-language "clojure", :age 80}
{:preferred-language "clojure", :age 30}
{:preferred-language "clojurescript", :age 38}
{:preferred-language "babashka", :age 48}
{:preferred-language "babashka", :age 10}
{:preferred-language "clojurescript", :age 41}
{:preferred-language "babashka", :age 89}
{:preferred-language "clojure", :age 56}
{:preferred-language "babashka", :age 78}
{:preferred-language "clojurescript", :age 18}
{:preferred-language "babashka", :age 71}
{:preferred-language "babashka", :age 83}
{:preferred-language "clojure", :age 91}
{:preferred-language "clojure", :age 39}
{:preferred-language "clojurescript", :age 42}
{:preferred-language "babashka", :age 36}]
(kind/pprint people-as-vectors)[["babashka" 80]
["clojure" 92]
["clojure" 10]
["clojure" 66]
["clojurescript" 57]
["clojurescript" 94]
["clojurescript" 31]
["babashka" 58]
["clojure" 75]
["clojurescript" 86]
["clojure" 34]
["clojurescript" 44]
["clojure" 41]
["clojure" 80]
["clojure" 30]
["clojurescript" 38]
["babashka" 48]
["babashka" 10]
["clojurescript" 41]
["babashka" 89]
["clojure" 56]
["babashka" 78]
["clojurescript" 18]
["babashka" 71]
["babashka" 83]
["clojure" 91]
["clojure" 39]
["clojurescript" 42]
["babashka" 36]]
tech.ml.dataset datasets currently use the default printing of the library, Let us create such a dataset using Tablecloth.
(require '[tablecloth.api :as tc])nil
(-> {:x (range 6)
:y [:A :B :C :A :B :C]}
tc/dataset)(-> {:x [1 [2 3] 4]
:y [:A :B :C]}
tc/dataset)(-> [{:x 1 :y 2 :z 3}
{:y 4 :z 5}]
tc/dataset)(-> people-as-maps
tc/dataset)The :kind/table kind can be handy for an interactive table view.
(kind/table
{:column-names [:preferred-language :age]
:row-vectors people-as-vectors})(kind/table
{:column-names [:preferred-language :age]
:row-maps people-as-maps})(-> people-as-maps
tc/dataset
kind/table)Hiccup, a popular Clojure way to represent HTML, can be specified by kind:
(kind/hiccup
[:big [:big [:p {:style ; https://www.htmlcsscolor.com/hex/7F5F3F
{:color "#7F5F3F"}}
"hello"]]])(import javax.imageio.ImageIO
java.net.URL)java.net.URL
(defonce image
(-> "https://upload.wikimedia.org/wikipedia/commons/2/2c/Clay-ss-2005.jpg"
(URL.)
(ImageIO/read)))nil
image(defn vega-lite-point-plot [data]
(-> {:data {:values data},
:mark "point"
:encoding
{:size {:field "w" :type "quantitative"}
:x {:field "x", :type "quantitative"},
:y {:field "y", :type "quantitative"},
:fill {:field "z", :type "nominal"}}}
kind/vega-lite))(defn random-data [n]
(->> (repeatedly n #(- (rand) 0.5))
(reductions +)
(map-indexed (fn [x y]
{:w (rand-int 9)
:z (rand-int 9)
:x x
:y y}))))(defn random-vega-lite-plot [n]
(-> n
random-data
vega-lite-point-plot))(random-vega-lite-plot 9)(def cytoscape-example
{:elements {:nodes [{:data {:id "a" :parent "b"} :position {:x 215 :y 85}}
{:data {:id "b"}}
{:data {:id "c" :parent "b"} :position {:x 300 :y 85}}
{:data {:id "d"} :position {:x 215 :y 175}}
{:data {:id "e"}}
{:data {:id "f" :parent "e"} :position {:x 300 :y 175}}]
:edges [{:data {:id "ad" :source "a" :target "d"}}
{:data {:id "eb" :source "e" :target "b"}}]}
:style [{:selector "node"
:css {:content "data(id)"
:text-valign "center"
:text-halign "center"}}
{:selector "parent"
:css {:text-valign "top"
:text-halign "center"}}
{:selector "edge"
:css {:curve-style "bezier"
:target-arrow-shape "triangle"}}]
:layout {:name "preset"
:padding 5}})(kind/cytoscape cytoscape-example)(kind/cytoscape [cytoscape-example
{:style {:height 100
:width 100}}])(kind/echarts
{:xAxis {:data ["Mon" "Tue" "Wed" "Thu" "Fri" "Sat" "Sun"]}
:yAxis {}
:series [{:type "bar"
:color ["#7F5F3F"]
:data [23 24 18 25 27 28 25]}]})inspired by the official MathBox.cljs tutorial
(kind/hiccup
'[(let [Data (fn []
[mathbox.primitives/Interval
{:expr (fn [emit x _i t]
(emit x (Math/sin (+ x t))))
:width 64
:channels 2}])
Curve (fn []
[:<>
[Data]
[mathbox.primitives/Line {:width 5
:color "#3090FF"}]])
Main (fn []
[mathbox.core/MathBox
{:container {:style {:height "400px" :width "100%"}}
:focus 3}
[mathbox.primitives/Camera {:position [0 0 3]
:proxy true}]
[mathbox.primitives/Cartesian
{:range [[-2 2] [-1 1]]
:scale [2 1]}
[mathbox.primitives/Axis {:axis 1 :width 3 :color "black"}]
[mathbox.primitives/Axis {:axis 2 :width 3 :color "black"}]
[mathbox.primitives/Grid {:width 2 :divideX 20 :divideY 10}]
[Curve]]])
*state (r/atom {:open? false})]
(fn []
[:div
[:button {:on-click #(swap! *state update :open? not)}
(if (:open? @*state)
"close"
"open")]
(when (:open? @*state)
[Main])]))])Clojure Delays are a common way to define computations that do not take place immediately. The computation takes place when dereferencing the value for the first time. Clay makes sure to dererence Delays when passing values for visualization. This is handy for slow example snippets and explorations, that one would typically not like to slow down the evaluation of the whole namespace, but would like to visualize them on demand and also include in them in the final document.
(delay
(Thread/sleep 500)
(+ 1 2))3
(delay
[:div [:big "hi......."]])[:div [:big "hi......."]]
The clay/check function allows to define tests that render accordingly, marking their failure or success.
(-> 2
(+ 3)
(clay/check = 4))(-> 2
(+ 3)
(clay/check = 5))We are considering a so-called "doctest" setup involving such checks, so that actual Clojure tests would be derived automatically from them. This would open the way for literate testing / testable documentation solutions, such as those we have been using in the past (e.g., in tutorials of ClojisR using Notespace v2).
:bye:bye